home *** CD-ROM | disk | FTP | other *** search
/ AOL File Library: 9,300 to 9,399 / 9300.zip / AOLDLs / HTML & Web Tools (MAC) / HTML_ MTX Web Publishing Tool / MTX Tool 1.3.sit / MTX Tool 1.3 / guide / format.txt < prev    next >
Text File  |  1996-02-22  |  7KB  |  172 lines
  1. Summary of Simple Marked Text (MTX) Format
  2. Version 1.3 - 2/15/96 by Richard Rathe
  3.  
  4. General Considerations
  5.  
  6.   Source file names have an .mtx extension.
  7.   HTML file names have an .html extension.
  8.   Files contain only ASCII characters
  9.     (return, linefeed, tab, space to ~).
  10.   Paragraphs are delimited by blank lines. Extra blank
  11.     lines will be eliminated. Adjacent lines will be
  12.     combined into a single paragraph.
  13.   Lines indented with spaces or tabs will become an item
  14.     in a list.
  15.   Items marked by a "N" use Netscape HTML extensions. For
  16.     maximum compatibility, avoid these tags.
  17.   The %HOME, %PARENT, %PREV, %NEXT and table tags have
  18.     changed since version 1.2. You may need to update
  19.     older MTX files to be compatible.
  20.  
  21. Special Tags
  22.  
  23.   %TITLE title text      - title for HTML page
  24.  N%TITLE $title text     - title with centered heading 
  25.   %HEADING none          - supress heading
  26.   %HEADING heading text  - heading different from title
  27.  N%HEADING $heading text - centered heading
  28.   %FILE file name        - name for HTML file
  29.   %IMAGES path name      - path for image files
  30.   %LOGO file name        - title inline graphic (.gif)
  31.  N%LOGO $file name       - centered title graphic (.gif)
  32.   %ICON file name        - heading inline graphic (.gif)
  33.  N%WATERMARK file name   - watermark graphic (.gif)
  34.  N%COLORS color list     - background and text colors
  35.   %HOME label text       - label for home document
  36.   %HOMEURL home url      - URL for home document
  37.   %HOMEURL none          - no URL for home document
  38.   %PARENT label text     - label for parent document
  39.   %PARENTURL parent url  - URL for parent document
  40.   %PARENTURL none        - no URL for parent document
  41.   %INDEX label text      - label for index document
  42.   %INDEXURL next url     - URL for index document
  43.   %INDEXURL none         - no URL for index document
  44.   %PREV label text       - label for previous document
  45.   %PREVURL prev url      - URL for previous document
  46.   %PREVURL none          - no URL for previous document
  47.   %NEXT label text       - label for next document
  48.   %NEXTURL next url      - URL for next document
  49.   %NEXTURL none          - no URL for next document
  50.   %BASE url path         - path for relative URLs
  51.   %PATH url path         - path for document only
  52.   %AUTHOR author text    - author or copyright info
  53.   %AUTHURL author url    - URL for author or copyright
  54.   %VERSION version text  - document version info
  55.   %VERSURL version url   - document version info
  56.   %OUTLINE none          - no outline
  57.   %OUTLINE long          - long outline
  58.   %LAYOUT cover          - suppress administrative info
  59.   %LAYOUT print          - suppress navigation info
  60.   %LAYOUT keyword        - file contains a keyword list
  61.   %LAYOUT noindex        - suppress indexing of this file
  62.  N%LAYOUT slide          - presentation slide format
  63.  N%REFRESH seconds       - client pull refresh
  64.  N%REFRESH seconds url   - client pull refresh with link
  65.   %COUNTER date url      - counter date and cgi url
  66.   %MTX version number    - MTX format version
  67.   %any other text        - comment line (ignored)
  68.  
  69.   NOTE: Each document will have a short outline at the top
  70.     unless otherwise specified. Links to email addresses
  71.     will be prefixed with "mailto:" automatically. Default
  72.     "Home," "Parent," "Previous," and "Next" labels will
  73.     be used if not otherwise specified.
  74.  
  75. Heading Tags (must occur at the beginning of line)
  76.  
  77.   #heading text      - primary outline heading
  78.   ##heading text     - secondary outline heading
  79.   ###...             - up to ##### (5) levels deep
  80.  N#$heading text     - centered heading
  81.   #text#url name     - heading link to url outside document
  82.   #text#=anchor name - use heading as named anchor
  83.  
  84.   NOTE: Any text that precedes the first #heading will
  85.     appear just after the title and before the outline.
  86.  
  87. Embedded Tags (can occur anywhere)
  88.  
  89.   {BR}  - line break
  90.   {P}   - paragraph break
  91.   {SP}  - non-breaking space
  92.   {*the text*}  - strong (bold) text
  93.   {!the text!}  - emphasized (italics) text
  94.   {@the text@}  - fixed font text
  95.   {=file name=} - inline graphic (.gif)
  96.   {+file name+} - inline (.gif) with linked (.jpg) graphic
  97.   {-file name-} - inline (.gif) with linked (.gif) graphic
  98.   {#file name#} - inline (.gif) with linked (.html) file
  99.   {#url name##} - link to quoted url
  100.   {#the text#url name#}     - link to url
  101.   {#the text#anchor name#}  - link to named anchor
  102.   {#the text#=anchor name#} - create named anchor
  103.  N{=file name alignment=}   - floating graphic (.gif)
  104.  N{+file name alignment+}   - floating graphic (.gif+.jpg)
  105.  N{CLEAR} - clear floating graphic alignment
  106.  
  107.   NOTE: File extensions (.gif, .jpg and .html) are
  108.     automatically added to file names. Linked .gif files
  109.     have an "L" added to the name (pictureL.gif). Anchor
  110.     names are case sensitive (#name <> #NAME). Links to
  111.     email addresses will be prefixed with "mailto:"
  112.     automatically. Graphic alignment may be either "left"
  113.     or "right." Floating graphic alignment must be cleared
  114.     using {CLEAR}.
  115.  
  116. List Tags (must occur after leading white space)
  117.  
  118.    text   - bulleted list item
  119.   #text   - numbered list item (1, 2, 3...)
  120.  N@text   - lettered list item (a, b, c...)
  121.  N!text   - roman numbered list item (I, II, III...)
  122.   +text   - glossary list title item (bold)
  123.   -text   - glossary list definition
  124.  
  125.   NOTE: Lists may be nested by using variable amounts
  126.     of leading white space.
  127.  
  128. Format Tags (must occur at the beginning of line)
  129.  
  130.   'text   - block quote
  131.  N''text  - pull quote
  132.   =text   - preformatted text
  133.  N$text   - centered text
  134.   -----   - horizontal rule (one or more dashes)
  135.  
  136. Question Tags (must occur at the beginning of line)
  137.  
  138.   ?x           - begin question (simple feedback)
  139.   ?xyz         - begin question (multiple correct answers)
  140.   ?x?          - begin question (extended feedback)
  141.   ?x?text      - begin question (custom extended feedback)
  142.   question text   - question text
  143.   @answer text    - answer text
  144.     feedback text - indented at least one space
  145.  
  146.   NOTE: Questions may have up to 26 (A-Z) answer choices.
  147.     Inline graphics may be used as part of any question,
  148.     answer, or feedback element.
  149.  
  150. Tables (each line must begin with "|") (N)
  151.  
  152. The first line must be one of the following:
  153.   |caption text         - caption text
  154.   |none                 - no caption
  155.   |caption|noborder     - caption for table with no border
  156.   |caption|nowide       - caption for minimal width table
  157.   |caption|nowideborder - caption with both of the above
  158.   |caption|noblanks     - caption for table with no blanks
  159. Subsequent lines can be variations of the following:
  160.   |text 1|text 2|text 3 - row with three cells
  161.   |text 1||text 3       - use empty cells where needed
  162.   |text 1|two   |text 3 - cells may be padded with spaces
  163.   |text 1|*     |text 3 - non-blank empty cell use "*"
  164.   |*col 1|*col 2|*col 3 - column headings begin with "*"
  165.   |*row 1|text 1|text 2 - row headings begin with "*"
  166.  
  167.   NOTE: Each line becomes one row in the table. Cells may
  168.   contain graphics or hypertext links. Use {BR} to force
  169.   word wrap within a cell. By default, tables will have
  170.   borders, blanks for empty cells, and resize to cover 95%
  171.   of the window side to side.
  172.